home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / os2 / srefv112.zip / SRCHINDX.DOC < prev    next >
Text File  |  1996-05-26  |  4KB  |  104 lines
  1. SRE-FILTER documentation file. 5/96
  2.  
  3. SWISH (Simple Web Indexing System for Humans) is a shareware/freeware
  4. program for indexing your site.  SRE-FILTER can use the output of SWISH
  5. to provide an internal "search engine".  That is, by calling the 
  6. server side program SRCHINDX.80, the client can search all 
  7. files (or all HTML files) on your site for keywords, and get a 
  8. scored, "selectable", list of URL's pointing to files 
  9. that contain these words.
  10.  
  11. You'll first need to obtain SWISH.  SWISH can be obtained from HOBBES
  12. (it might be still in INCOMING), or from 
  13. ftp://ftp.eit.com/pub/web.software/swish/. Read the instructions (they
  14. are in HTML format), and try it out.
  15.  
  16. To help with this process, you can look at SAMPLES.SWI, and SAMPLES.CON that
  17. are included with SRE-FILTER (they are an index, and the file used
  18. to create this index, of SRE-FILTER's SAMPLE directory).
  19.  
  20.  
  21. The SRE-FILTER hook into this index (which is used to create the
  22. list of urls) is SRCHINDX.80.  It is invoked like any other "server side
  23. program"; SRCHINDX.HTM provides an example of it's use.
  24.  
  25. SRCHINDX.80 takes the following options:
  26.  
  27. Options:
  28. KEYWORD: List of words to search for, with OR AND NOT as logical
  29.          controls (AND is assumed). 
  30.  
  31.          If KEYWORD is not included, a keyword of HELP is used.
  32.  
  33. INDEX::   Index file to search for (typically provided as type=hidden)
  34.           This is the "index" file created by SWISH.
  35.  
  36.                 If INDEX is not included, INDEX.SWI is assumed
  37.                 INDEX is assumed to be in your working directory.
  38.  
  39. OPTION1...OPTION9: A list of options to modify the search.
  40.                   Valid ones include
  41.                     -t xxxxx ; where xxxx can include any of HBethc
  42.                     -m #lines
  43.  
  44. HEADER:  H1 header to use (default used if none provided )
  45.          A default header is used if HEADER is not included.
  46.  
  47. COMMENT1 .. COMMENT9: Comments to place (using <EM>) under header
  48.  
  49. CONDITION:  Control search logic.
  50.        Values: OR NOT
  51.        "OR" or "NOT"  will placed between keywords.
  52.         If any other value, no changes to keyword list.
  53.        If CONDITION is not included, the implicit default of  "and" is used.
  54.       Note that if CONDITION is used, no substitution if there
  55.       already is a NOT, OR or AND between words.
  56.       (this prevents overriding explicit instructions)
  57.  
  58.     Caution: CONDITION  will not work well with (phrases) or
  59.     in combination with  complex user specified search strings.
  60.  
  61. SUMMARY: NO  EXPLICIT  CREATE
  62.         Use this to add "summary" information below each entry.
  63.         0 : no summary
  64.         NO: do not add summary info (the default ), but check
  65.             for existence of file
  66.         YES: look for name="description" (or http-equiv="descripiton")
  67.                  and use the "content= field) -- this works for TEXT/HTML
  68.                  files only.
  69.         CREATE: If no name=found, then use the first several
  70.                 <h1, h2, h3 elements (for TEXT/HTML files only)
  71.                 or the first 300 characters (TEXT/PLAIN fileso only)
  72.  
  73.     Note that EXPLICIT and CREATE may slow down "index creation" time 
  74.     considerably (SRE-FILTER will parse all matching files, 
  75.    looking for the appropriate fields)
  76.  
  77.    If summary is selected, SRE-FILTER will highlight the keywords
  78.    that may appear in the summary.
  79.  
  80. Again, SRCHINDX.HTM  provides an example of how to use SRCHINDX.80 --
  81. it should be modified for your site (or, just be sure that SAMPLES.SWI
  82. in your working directory is appropriate.
  83.  
  84.  
  85.  
  86. ---- General comment:
  87.   Actually, all that SRCHINDX requires is that some program called
  88. "swish" returns a list of files structured as:
  89. score  url   title   bytes
  90.  
  91. Note that the url can be local (/mydir/myfile.htm)
  92. or remote (http://www.wow.org/afile.htm)
  93.  
  94. In either case (and note that you can set up your INDEX.SWI file
  95. to return http:// style url's that NEED NOT point to your site),
  96. the list is returned, and summaries will be made if requested.
  97.  
  98. Note that for remote urls, creation of summaries may be time consuming.
  99.  
  100.  
  101. Alternative: An alternative indexer, that looks across all files in
  102. your data directory for matching words, is the SEARCH.EXE cgi-bin
  103. program (available at FTP.NCC.COM).
  104.